Configuring Environment Variables ================================= The following environment variables need to be set in order to use the CUBRID. The necessary environment variables are automatically set when the CUBRID system is installed or can be changed, as needed, by the user. CUBRID Environment Variables ---------------------------- * **CUBRID**: The default environment variable that designates the location where the CUBRID is installed. This variable must be set accurately since all programs included in the CUBRID system uses this environment variable as reference. * **CUBRID_DATABASES**: The environment variable that designates the location of the **databases.txt** file. The CUBRID system stores the absolute path of database volumes in the **$CUBRID_DATABASES/databases.txt** file. See :ref:`databases-txt-file`. * **CUBRID_LANG**: The environment variable that specifies the display language of utility usage or error messages in CUBRID. Currently, CUBRID provides English (en_US) and Korean (ko_KR.euckr and ko_KR.utf8). it is not a mandatory setting. Therefore, if the variable has not been set, then refer to the LANG environment variable or use en_US, which is the default value. For details, see :ref:`language-setting`. * **CUBRID_TMP**: The environment variable that specifies the location where the cub_master process and the cub_broker process store the UNIX domain socket file in CUBRID for Linux. If it is not specified, the cub_master process stores the UNIX domain socket file under the **/tmp** directory and the cub_broker process stores the UNIX domain socket file under the **$CUBRID/var/CUBRID_SOCK** directory (not used in CUBRID for Windows). **CUBRID_TMP** value has some constraints, which are as follows: * Since the maximum length of the UNIX socket path is 108, when a path longer than 108 is entered in **$CUBRID_TMP**, an error is displayed. :: $ export CUBRID_TMP=/home1/siwankim/cubrid=/tmp/123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789 $ cubrid server start apricot The $CUBRID_TMP is too long. (/home1/siwankim/cubrid=/tmp/123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789) * When the relative path is entered, an error is displayed. :: $ export CUBRID_TMP=./var $ cubrid server start apricot The $CUBRID_TMP should be an absolute path. (./var) **CUBRID_TMP** can be used to avoid the following problems that can occur at the default path of the UNIX domain socket that CUBRID uses. * **/tmp** is used to store the temporary files in Linux. If the system administrator periodically and voluntarily cleans the space, the UNIX domain socket may be removed. In this case, configure **$CUBRID_TMP** to another path, not **/tmp**. * The maximum length of the UNIX socket path is 108. When the installation path of CUBRID is too long and the **$CUBRID/var/CUBRID_SOCK** path that store the UNIX socket path for cub_broker exceeds 108 characters, the broker cannot be executed. Therefore, the path of **$CUBRID_TMP** must not exceed 1008 characters. The above mentioned environment variables are set when the CUBRID is installed. However, the following commands can be used to verify the setting. * For Linux : :: % printenv CUBRID % printenv CUBRID_DATABASES % printenv CUBRID_LANG % printenv CUBRID TMP * In Windows : :: C:\> set CUBRID OS Environment and Java Environment Variables --------------------------------------------- * PATH: In the Linux environment, the directory **$CUBRID/bin**, which includes a CUBRID system executable file, must be included in the PATH environment variable. * LD_LIBRARY_PATH: In the Linux environment, **$CUBRID/lib**, which is the CUBRID system's dynamic library file (libjvm.so), must be included in the **LD_LIBRARY_PATH** (or **SHLIB_PATH** or **LIBPATH**) environment variable. * Path: In the Windows environment, the **%CUBRID%\\bin**, which is a directory that contains CUBRID system's execution file, must be included in the **Path** environment variable. * JAVA_HOME: To use the Java stored procedure in the CUBRID system, the Java Virtual Machine (JVM) version 1.6 or later must be installed, and the **JAVA_HOME** environment variable must designate the concerned directory. See the :ref:`jsp-environment-configuration`. **Configuring the Environment Variable** **For Windows** If the CUBRID system has been installed on Windows, then the installation program automatically sets the necessary environment variable. Select [Systems Properties] in [My Computer] and select the [Advanced] tab. Click the [Environment Variable] button and check the setting in the [System Variable]. The settings can be changed by clicking on the [Edit] button. See the Windows help for more information on how to change the environment variable on Windows. .. image:: /images/image4.png **For Linux** If the CUBRID system has been installed on Linux, the installation program automatically creates the **.cubrid.sh** or **.cubrid.csh** file and makes configurations so that the files are automatically called from the installation account's shell log-in script. The following is the contents of . **cubrid.sh** environment variable configuration that was created in an environment that uses sh, bash, etc. :: CUBRID=/home1/cub_user/CUBRID CUBRID_DATABASES=/home1/cub_user/CUBRID/databases CUBRID_LANG=en_US ld_lib_path=`printenv LD_LIBRARY_PATH` if [ "$ld_lib_path" = "" ] then LD_LIBRARY_PATH=$CUBRID/lib else LD_LIBRARY_PATH=$CUBRID/lib:$LD_LIBRARY_PATH fi SHLIB_PATH=$LD_LIBRARY_PATH LIBPATH=$LD_LIBRARY_PATH PATH=$CUBRID/bin:$CUBRID/cubridmanager:$PATH export CUBRID export CUBRID_DATABASES export CUBRID_LANG export LD_LIBRARY_PATH export SHLIB_PATH export LIBPATH export PATH .. _language-setting: Language Setting ---------------- The language that will be used in the CUBRID DBMS can be designated with the **CUBRID_LANG** environment variable. The following are examples of values that can currently be set in the **CUBRID_LANG** environment variable. * **en_US**: English (Default) * **ko_KR.euckr**: Korean EUC-KR encoding * **ko_KR.utf8**: Korean UTF-8 encoding Language and charset setting of CUBRID affects read and write data. The language is used for messages displayed by the program. The default value of **CUBRID_LANG** is **en_US** while installing the product. Language setting in the system does not mean that the character set of data which is stored in the database of CUBRID 2008 R4.4 or before. Even if CUBRID_LANG is specified as ko_KR.utf8, stored data does not transformed as UTF-8 enconding. If the CUBRID_LANG environment variable has not been set, then refer to the LANG environment variable. If CUBRID_LANG or LANG has invalid value, it is replaced as en_US, which is the default value. .. _connect-to-cubrid-server: Port Setting ============ If ports are closed, the ports used by CUBRID should be opened. The following table summarizes the ports used by CUBRID. Each port on the listener that waits for connection from the opposite side should be opened. To open the ports for a specific process on the Linux firewall, follow the guide described for the corresponding firewall program. If available ports for Windows are used, you cannot know which port will be opened. In this case, enter "firewall" in the "Control Panel" of the Windows menu and then choose "Windows Firewall> Allow a program or functionality through Windows Firewall" and then add the program for which port should be opened. This method can be used for the case that it is difficult to specify a specific port in Windows. This method is recommended since it is safer to add a program to the Allowed programs list than to open a port without specifying a program on the Windows firewall. * Add "%CUBRID%\\bin\\cub_broker.exe" to open all ports for cub_broker. * Add "%CUBRID%\\bin\\cub_cas.exe" to open all ports for CAS. * Add "%CUBRID%\\bin\\cub_master.exe" to open all ports for cub_master. * Add "%CUBRID%\\bin\\cub_server.exe" to open all ports for cub_server. * Add "%CUBRID%\\bin\\cub_cmserver.exe" to open all ports for the CUBRID Manager. * Add "%CUBRID%\\bin\\cub_cmhttpd.exe" to open all ports for the CUBRID Web Manager. If you use CUBRID for Linux at the broker equipment or the DB server equipment, all of Linux ports should be opened. If you use CUBRID for Windows at the broker equipment or the DB server equipment, all of Linux ports should be opened or the related processes should be added to the program list allowed for the Windows firewall. +---------------+---------------+---------------+----------------+-----------------------------------------------------+--------------------------+------------------------+ | Label | Listener | Requester | Linux Port | Windows Port | Firewall Port Setting | Description | +===============+===============+===============+================+=====================================================+==========================+========================+ | Default use | cub_broker | application | BROKER_PORT | BROKER_PORT | Open | One-time connection | | +---------------+---------------+----------------+-----------------------------------------------------+--------------------------+------------------------+ | | CAS | application | BROKER_PORT | APPL_SERVER_PORT ~ (APP_SERVER_PORT + # of CAS - 1) | Open | Keep connected | | +---------------+---------------+----------------+-----------------------------------------------------+--------------------------+------------------------+ | | cub_master | CAS | cubrid_port_id | cubrid_port_id | Open | One-time connection | | +---------------+---------------+----------------+-----------------------------------------------------+--------------------------+------------------------+ | | cub_server | CAS | cubrid_port_id | A random available port | Linux: Open | Keep connected | | | | | | | | | | | | | | | Windows: Program | | | +---------------+---------------+----------------+-----------------------------------------------------+--------------------------+------------------------+ | | Client | cub_server | ECHO(7) | ECHO(7) | Open | Periodical connection | | | equipment | | | | | | | +---------------+---------------+----------------+-----------------------------------------------------+--------------------------+------------------------+ | | Server | CAS, CSQL | ECHO(7) | ECHO(7) | Open | Periodical connection | | | equipment | | | | | | +---------------+---------------+---------------+----------------+-----------------------------------------------------+--------------------------+------------------------+ | HA used | cub_broker | application | BROKER_PORT | Not supported | Open | One-time connection | | +---------------+---------------+----------------+-----------------------------------------------------+--------------------------+------------------------+ | | CAS | application | BROKER_PORT | Not supported | Open | Keep connected | | +---------------+---------------+----------------+-----------------------------------------------------+--------------------------+------------------------+ | | cub_master | CAS | cubrid_port_id | Not supported | Open | One-time connection | | +---------------+---------------+----------------+-----------------------------------------------------+--------------------------+------------------------+ | | cub_master | cub_master | ha_port_id | Not supported | Open | Periodical connection, | | | | | | | | check the heartbeat | | | (slave) | (master) | | | | | | +---------------+---------------+----------------+-----------------------------------------------------+--------------------------+------------------------+ | | cub_master | cub_master | ha_port_id | Not supported | Open | Periodical connection, | | | | | | | | check the heartbeat | | | (master) | (slave) | | | | | | +---------------+---------------+----------------+-----------------------------------------------------+--------------------------+------------------------+ | | cub_server | CAS | cubrid_port_id | Not supported | Open | Keep connected | | +---------------+---------------+----------------+-----------------------------------------------------+--------------------------+------------------------+ | | Client | cub_server | ECHO(7) | Not supported | Open | Periodical connection | | | equipment | | | | | | | +---------------+---------------+----------------+-----------------------------------------------------+--------------------------+------------------------+ | | Server | CAS, CSQL, | ECHO(7) | Not supported | Open | Periodical connection | | | equipment | copylogdb, | | | | | | | | applylogdb | | | | | +---------------+---------------+---------------+----------------+-----------------------------------------------------+--------------------------+------------------------+ | SHARD used | shard_broker | application | BROKER_PORT | Not supported | Open | One-time connection | | +---------------+---------------+----------------+-----------------------------------------------------+--------------------------+------------------------+ | | shard_proxy | application | BROKER_PORT | Not supported | Open | Keep connected | +---------------+---------------+---------------+----------------+-----------------------------------------------------+--------------------------+------------------------+ | Manager, | Manager | application | 8001, 8002 | 8001, 8002 | Open | | | | server | | | | | | | Web Manager +---------------+---------------+----------------+-----------------------------------------------------+--------------------------+------------------------+ | used | Web Manager | application | 8282 | 8282 | Open | | | | server | | | | | | +---------------+---------------+---------------+----------------+-----------------------------------------------------+--------------------------+------------------------+ The detailed description on each classification is given as follows. .. _cubrid-basic-ports: Default Ports for CUBRID ------------------------ The following table summarizes the ports required for each OS, based on the listening processes. Each port on the listener should be opened. +---------------+---------------+----------------+-----------------------------------------------------+--------------------------+------------------------+ | Listener | Requester | Linux port | Windows port | Firewall Port Setting | Description | +===============+===============+================+=====================================================+==========================+========================+ | cub_broker | application | BROKER_PORT | BROKER_PORT | Open | One-time connection | +---------------+---------------+----------------+-----------------------------------------------------+--------------------------+------------------------+ | CAS | application | BROKER_PORT | APPL_SERVER_PORT ~ (APP_SERVER_PORT + # of CAS - 1) | Open | Keep connected | +---------------+---------------+----------------+-----------------------------------------------------+--------------------------+------------------------+ | cub_master | CAS | cubrid_port_id | cubrid_port_id | Open | One-time connection | +---------------+---------------+----------------+-----------------------------------------------------+--------------------------+------------------------+ | cub_server | CAS | cubrid_port_id | A random available port | Linux: Open | Keep connected | | | | | | | | | | | | | Windows: Program | | +---------------+---------------+----------------+-----------------------------------------------------+--------------------------+------------------------+ | Client | cub_server | ECHO(7) | ECHO(7) | Open | Periodical connection | | equipment(*) | | | | | | +---------------+---------------+----------------+-----------------------------------------------------+--------------------------+------------------------+ | Server | CAS, CSQL | ECHO(7) | ECHO(7) | Open | Periodical connection | | equipment(**) | | | | | | +---------------+---------------+----------------+-----------------------------------------------------+--------------------------+------------------------+ (*): The equipment which has the CAS or CSQL process (**): The equipment which has the cub_server .. note:: In Windows, you cannot specify the ports to open because CAS randomly specifies the ports as accessing the cub_server. In this case, add "%CUBRID%\\bin\\cub_server.exe" to "Windows Firewall > Allowed programs". As the server process (cub_server) and the client processes (CAS, CSQL) cross-check if the opposite node is normally running or not by using the ECHO(7) port, you should open the ECHO(7) port if there is a firewall. If the ECHO port cannot be opened for both the server and the client, set the **check_peer_alive** parameter value of the cubrid.conf to none. The relation of connection between processes is as follows: :: application - cub_broker -> CAS - cub_master -> cub_server * application: The application process * cub_broker: The broker server process. It selects CAS to connect with the application. * CAS: The broker application server process. It relays the application and the cub_server. * cub_master: The master process. It selects the cub_server to connect with the CAS. * cub_server: The database server process The symbols of relation between processes and the meaning are as follows: * \- : Indicates that the connection is made only once for the initial. * ->, <- : Indicates that the connection is maintained. The right side of -> or the left side of <- is the party that the arrow symbol indicates. The party that the arrow symbol indicates is the listener which listens to the opposite process. * (master): Indicates the master node in the HA configuration. * (slave): Indicates the slave node in the HA configuration. The connection process between the application and the DB is as follows: #. The application tries to connect to the cub_broker through the broker port (BROKER_PORT) set in the cubrid_broker.conf. #. The cub_broker selects a connectable CAS. #. The application and CAS are connected. In Linux, BROKER_PORT, which is used as an application, is connected to CAS through the Unix domain socket. In Windows, since the Unix domain socket cannot be used, an application and CAS are connected through a port of which the number is the sum of the corresponding CAS ID and the APPL_SERVER_PORT value set in the cubrid_broker.conf. If the APPL_SERVER_PORT value has not been set, the port value connected to the first CAS is BROKER_PORT + 1. For example, if the BROKER_PORT is 33000 and the APPL_SERVER_PORT value has not been set in Windows, the ports used between the application and CAS are as follows: * The port used to connect the application to the CAS(1): 33001 * The port used to connect the application to the CAS(2): 33002 * The port used to connect the application to the CAS(3): 33003 #. CAS sends a request of connecting with the cub_server to the cub_master through the cubrid_port_id port set in the cubrid.conf. #. CAS and the cub_server are connected. In Linux, you should use the cubrid_port_id port as CAS is connected to the cub_server through the Unix domain socket. In Windows, CAS is connected to the cub_server through a random available port as the Unix domain socket cannot be used. If the DB server is running in Windows, a random available port is used between the broker equipment and the DB server equipment. In this case, note that the operation may not be successful if a firewall blocks the port for the process between the two equipment. #. After that, CAS keeps connection with the cub_server even if the application is terminated until the CAS restarts. .. _cubrid-ha-ports: Ports for CUBRID HA ------------------- The CUBRID HA is supported in Linux only. The following table summarizes the ports required for each OS, based on the listening processes. Each port on the listener should be opened. +---------------+---------------+----------------+--------------------------+------------------------+ | Listener | Requester | Linux port | Firewall Port Setting | Description | +===============+===============+================+==========================+========================+ | cub_broker | application | BROKER_PORT | Open | One-time connection | +---------------+---------------+----------------+--------------------------+------------------------+ | CAS | application | BROKER_PORT | Open | Keep connected | +---------------+---------------+----------------+--------------------------+------------------------+ | cub_master | CAS | cubrid_port_id | Open | One-time connection | +---------------+---------------+----------------+--------------------------+------------------------+ | cub_master | cub_master | ha_port_id | Open | Periodical connection, | | | | | | check the heartbeat | | (slave) | (master) | | | | +---------------+---------------+----------------+--------------------------+------------------------+ | cub_master | cub_master | ha_port_id | Open | Periodical connection, | | | | | | check the heartbeat | | (master) | (slave) | | | | +---------------+---------------+----------------+--------------------------+------------------------+ | cub_server | CAS | cubrid_port_id | Open | Keep connected | +---------------+---------------+----------------+--------------------------+------------------------+ | Client | cub_server | ECHO(7) | Open | Periodical connection | | equipment(*) | | | | | +---------------+---------------+----------------+--------------------------+------------------------+ | Server | CAS, CSQL, | ECHO(7) | Open | Periodical connection | | equipment(**) | copylogdb, | | | | | | applylogdb | | | | +---------------+---------------+----------------+--------------------------+------------------------+ (*): The equipment which has the CAS, CSQL, copylogdb, or applylogdb process (**): The equipment which has the cub_server As the server process (cub_server) and the client processes (CAS, CSQL, copylogdb, applylogdb, etc.) cross-check if the opposite node is normally running or not by using the ECHO(7) port, you should open the ECHO(7) port if there is a firewall. If the ECHO port cannot be opened for both the server and the client, set the **check_peer_alive** parameter value of the cubrid.conf to none. The relation of connection between processes is as follows: :: application - cub_broker -> CAS - cub_master(master) <-> cub_master(slave) -> cub_server(master) cub_server(slave) <- applylogdb(slave) <----------------------- copylogdb(slave) * cub_master(master): the master process on the master node in the CUBRID HA configuration. It checks if the peer node is alive. * cub_master(slave): the master process on the slave node in the CUBRID HA configuration. It checks if the peer node is alive. * copylogdb(slave): the process which copies the replication log on the slave node in the CUBRID HA configuration * applylogdb(slave): the process which applies the replication log on the slave node in the CUBRID HA configuration For easy understanding for the replication process from the master node to the slave node, the applylogdb and copylogdb on the master node and CAS on the slave node have been omitted. The symbols of relation between processes and the meaning are as follows: * \- : Indicates that the connection is made only once for the initial. * ->, <- : Indicates that the connection is maintained. The right side of -> or the left side of <- is the party that the arrow symbol indicates. The party that the arrow symbol indicates is the listener which listens to the opposite process. * (master): Indicates the master node in the HA configuration. * (slave): Indicates the slave node in the HA configuration. The connection process between the application and the DB is identical with :ref:`cubrid-basic-ports`\. This section describes the connection process between the master node and the slave node when the master DB and the slave DB are configured 1:1 by the CUBRID HA. #. The ha_port_id set in the cubrid_ha.conf is used between the cub_master(master) and the cub_master(slave). #. The copylogdb(slave) sends a request for connecting with the master DB to the cub_master(master) through the port set in the cubrid_port_id of the cubrid.conf on the slave node. Finally, the copylogdb(slave) is connected with the cub_server(master). #. The applylogdb(slave) sends a request for connecting with the slave DB to the cub_master(slave) through the port set in the cubrid_port_id of the cubrid.conf on the slave node. Finally, the applylogdb(slave) is connected with the cub_server(slave). On the master node, the applylogdb and the copylogdb run for the case that the master node is switched to the slave node. .. _cubrid-shard-ports: Ports for CUBRID SHARD ---------------------- The CUBRID SHARD is supported in Linux only. The following table summarizes the ports required for Linux, based on the listening processes. Each port on the listener should be opened(In CUBRID 2008 R4.4, SHARD feature can be used only in Linux.) +-------------------+--------------+----------------+--------------------------+------------------------+ | Listener | requester | Linux port | Firewall Port Setting | Description | +===================+==============+================+==========================+========================+ | shard_broker | application | BROKER_PORT | Open | One-time connection | +-------------------+--------------+----------------+--------------------------+------------------------+ | shard_proxy | application | BROKER_PORT | Open | Keep connected | +-------------------+--------------+----------------+--------------------------+------------------------+ The connection process between the application and the server for the CUBRID SHARD configuration is as follows. The shard CAS and the shard proxy have already been connected when starting the CUBRID SHARD (cubrid shard start). #. The application tries to connect with the shard broker through the BROKER_PORT set in the shard.conf. #. The shard broker selects the connectable shard proxy. #. The application and the shard proxy are connected. The minimum number and the maximum number of the shard proxy are determined by MIN_NUM_PROXY and MAX_NUM_PROXY of the shard.conf. In Linux, the application is connected to the shard proxy through the Unix domain socket. For example, in Linux, if BROKER_PORT is 45000 and MAX_NUM_PROXY is 3, only one port is used: 45000. * The port used to connect the application to the shard proxy(1): 45000, the port used to connect the shard CAS to the shard proxy(1): None * The port used to connect the application to the shard proxy(2): 45000, the port used to connect the shard CAS to the shard proxy(2): None * The port used to connect the application to the shard proxy(3): 45000, the port used to connect the shard CAS to the shard proxy(3): None .. note:: In the current version, MIN_NUM_PROXY is not used but only MAX_NUM_PROXY. #. The shard CAS and the shard proxy have already been connected when starting the CUBRID SHARD (cubrid shard start). In addition, the processes are always in one equipment, requiring no remote access. When the shard CAS is connected to the shard proxy, the Unix domain socket is used in Linux. Multiple shard CASes can be connected to one shard proxy. The minimum number and the maximum number of the shard CAS are determined by MIN_NUM_APPL_SERVER and MAX_NUM_APPL_SERVER of the shard.conf. The maximum number of shard CASes which can be connected to one shard proxy simultaneously is determined based on MAX_CLIENT of the shard.conf. .. _cwm-cm-ports: Ports for CUBRID Web Manager and CUBRID Manager Server ------------------------------------------------------ The following table summarizes the ports, based on the listening processes, used for the CUBRID Web Manager and the CUBRID Manager server. The ports are identical regardless of the OS type. +--------------------------+--------------+----------------+--------------------------+ | Listener | Requester | Port | Firewall Port Setting | +==========================+==============+================+==========================+ | Manager server | application | 8001, 8002 | Open | +--------------------------+--------------+----------------+--------------------------+ | Web Manager server | application | 8282 | Open | +--------------------------+--------------+----------------+--------------------------+ * The port used when the CUBRID Manager client accesses the CUBRID Manager server process is **cm_port** and **cm_port** + 1 of the cm.conf. The default value of the **cm_port** is 8001. * The port used when the CUBRID Web Manager client accesses the CUBRID Web Manager server process is **listen** of the cm_httpd.conf. The default value of the port is 8282.